//! \file Whitespace.cpp
//! \brief TODO: Document
// -----------------------------------------------------------------------------
//! This program is free software; you can redistribute it and/or
//! modify it under the terms of the GNU General Public License
//! as published by the Free Software Foundation; either version 2
//! of the License, or (at your option) any later version.
//!
//! This program is distributed in the hope that it will be useful,
//! but WITHOUT ANY WARRANTY; without even the implied warranty of
//! MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
//! GNU General Public License for more details.
//!
//! You should have received a copy of the GNU General Public License
//! along with this program; if not, write to the Free Software Foundation,
//! Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
// -----------------------------------------------------------------------------

// Project Includes
#include "CEagle.h"
#include "CJaguar.h"

// Standard Includes
#include <Pluma/Connector.hpp>

// =====[ Public Methods ]======================================================


//! \brief Provides the host a plugin connection.
//!
//! This is the entry point of the plugin for the host.  In other words, the
//! Plugin connects to hosts via this function.
//!
//! \param [in] Host
//!   TODO: document
//!
//! \retval Status
//!   The success status of the requested operation.
//!   - true:  The host did connect to the plugin as requested.
//!   - false: The host did not connect to the plugin as requested.
//!   .
//!
//! \b Example: \code
//! TODO: document
//! \endcode
PLUMA_CONNECTOR bool connect(pluma::Host& Host)
{
  // TODO: comment
  Host.add(new code_sheriff::CEagleProvider());
  Host.add(new code_sheriff::CJaguarProvider());

  // Finally, return success.
  return true;
}
